Finance API

Overview

This page covers the methods and endpoints associated with finance operations. With the Finance API you can access and manage VLD fees.

Authentication

Use the following header parameters for all requests:

Headers
Authentication string required	Authentication bearer token See Authentication Guide
X-IAA-OW-ID integer required	Organization Workspace ID Header

Finance Details

Get Customer PLD Finance Details

GET /api/v3/fa/customer/{customerOwId}/pld-fees

Get finance details for a Customer's Provider Level Data (PLD).

Read more about PLD in our Insights API or our Help Center articles: Provider Level Data (PLD) Insights Reports.

Path Parameters
customerOwId integer	Customer Organization Workspace ID

Response Properties

id integer	Customer ID
owId integer	Organization Workspace ID
pldRate integer	PLD rate for workspace Customer
pldEnabled boolean	Boolean flag to enable and disable PLD feature for Advertiser Customer
pldMarkupType string	PLD markup type: "Absolute" or "Percentage"
pldMarkupTypeId integer	PLD markup type ID: "Absolute" or "Percentage"
pldMarkupValue integer	PLD markup value for Advertiser Customer

JSON

ResponsePLD DetailsPLD Flag EnabledPLD Flag Disabled

Response 200

{
    "success": true,
    "data": {
        "id": 1,
        "pldRate": 3
    }
}

Response 200

{
    "success": true,
    "data": {
        "id": 3,
        "owId": 201427,
        "pldRate": 3,
        "pldEnabled": true,
        "pldMarkupType": "Percentage",
        "pldMarkupValue": 10
    }
}

Response 200

{
  "success": true,
  "data": {
    "pldRate": 3,
    "pldEnabled": false
  }
}

TypeScript

See TypeScript Prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          vldRate: number;
        }
      }
    };
  };
}

function getPLDFees(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/fa/customer/{customerOwId}/pld-fees',
    params: {
      path: {
        customerowId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update Customer PLD Details

PATCH /api/v3/fa/customer/pld-fees

Update a Customer's PLD details.

Request Schema
id integer	ID
owId integer required	OW ID of the Customer to update details
pldRate integer	PLD rate for workspace Customer
pldEnabled boolean	Boolean flag to enable and disable PLD feature for Advertiser Customer
pldMarkupTypeId integer	PLD markup type ID to represent markup types: Absolute or Percentage
pldMarkupValue integer	PLD markup value for Advertiser Customer: "Absolute" or "Percentage"

Response Properties

id integer	ID
message string	Success message

JSON

Request Sample

{
    "id": 0,
    "owId": 0,
    "pldRate": 0,
    "pldEnabled": true,
    "pldMarkupType": "string",
    "pldMarkupTypeId": 0,
    "pldMarkupValue": 9999
}

Response 200

{
    "success": true,
    "data": {
        "id": 1,
        "message": "PLD Rate updated successfully. The new rate applies only to newly created VLDs"
    }
}

TypeScript

See TypeScript Prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        id: number;
        owId: number;
        pldRate: number;
        pldEnabled: boolean;
        pldMarkupType: string;
        pldMarkupTypeId: number;
        pldMarkupValue: number;
      }
    };
  };
}

function editPLDFees(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/fa/customer/pld-fees',
    requestBody: {
      content: {
        "application/json": {
          id?: `number`,
          owId: `number`,
          pldRate?: `number`,
          pldEnabled?: `boolean`,
          pldMarkupType?: `string`,
          pldMarkupTypeId?: `number`,
          pldMarkupValue?: `number`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Customer SLS Finance Details

GET /api/v3/fa/customer/{customerOwId}/sls-fees

Get finance details for a Customer's Script Lift Study (SLS).

Read more about SLS in our Insights API or our Help Center articles: Script Lift Study (SLS) Insights Reports.

Path Parameters
customerOwId integer	Customer Organization Workspace ID

Response Properties

id integer	Customer ID
owId integer	Organization Workspace ID
slsRate integer	SLS rate for workspace Customer
slsEnabled boolean	Boolean flag to enable and disable SLS feature for Advertiser Customer
slsMarkupTypeId integer	SLS markup type ID: "Absolute" or "Percentage"
slsMarkupType string	SLS markup type: "Absolute" or "Percentage"
slsMarkupValue integer	SLS markup value for Advertiser Customer

JSON

ResponseSLS DetailsSLS Flag EnabledSLS Flag Disabled

Response 200

{
    "success": true,
    "data": {
        "id": 1,
        "slsRate": 3
    }
}

Response 200

{
    "success": true,
    "data": {
        "id": 3,
        "owId": 201427,
        "slsRate": 3,
        "slsEnabled": true,
        "slsMarkupType": "Percentage",
        "slsMarkupValue": 10
    }
}

Response 200

{
  "success": true,
  "data": {
    "slsRate": 3,
    "slsEnabled": false
  }
}

TypeScript

See TypeScript Prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          slsRate: number;
        }
      }
    };
  };
}

function getSLSFees(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/fa/customer/{customerOwId}/sls-fees',
    params: {
      path: {
        customerowId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update Customer SLS Details

PATCH /api/v3/fa/customer/sls-fees

Update a Customer's SLS details.

Request Schema
id integer	ID
owId integer required	OW ID of the Customer to update details
slsRate integer	SLS rate for workspace Customer
slsEnabled boolean	Boolean flag to enable and disable SLS feature for Advertiser Customer
slsMarkupType string	SLS markup type: "Absolute" or "Percentage"
slsMarkupTypeId integer	SLS markup type ID: Absolute or Percentage
slsMarkupValue integer	SLS markup value for Advertiser Customer

Response Properties

id integer	ID
message string	Success message

JSON

Request Sample

{
    "id": 0,
    "owId": 0,
    "slsRate": 0,
    "slsEnabled": true,
    "slsMarkupType": "string",
    "slsMarkupTypeId": 0,
    "slsMarkupValue": 9999
}

Response 200

{
    "success": true,
    "data": {
        "id": 1,
        "message": "SLS Rate updated successfully. The new rate applies only to newly created VLDs"
    }
}

TypeScript

See TypeScript Prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        id: number;
        owId: number;
        slsRate: number;
        slsEnabled: boolean;
        slsMarkupType: string;
        slsMarkupTypeId: number;
        slsMarkupValue: number;
      }
    };
  };
}

function editSLSFees(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/fa/customer/sls-fees',
    requestBody: {
      content: {
        "application/json": {
          id?: `number`,
          owId: `number`,
          slsRate?: `number`,
          slsEnabled?: `boolean`,
          slsMarkupType?: `string`,
          slsMarkupTypeId?: `number`,
          slsMarkupValue?: `number`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---